/*

 * Licensed to the Apache Software Foundation (ASF) under one

 * or more contributor license agreements.  See the NOTICE file

 * distributed with this work for additional information

 * regarding copyright ownership.  The ASF licenses this file

 * to you under the Apache License, Version 2.0 (the

 * "License"); you may not use this file except in compliance

 * with the License.  You may obtain a copy of the License at

 *

 *     http://www.apache.org/licenses/LICENSE-2.0

 *

 * Unless required by applicable law or agreed to in writing, software

 * distributed under the License is distributed on an "AS IS" BASIS,

 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 * See the License for the specific language governing permissions and

 * limitations under the License.

 */

package com.bff.gaia.unified.fn.harness;



import com.bff.gaia.unified.fn.harness.control.BundleSplitListener;

import com.bff.gaia.unified.fn.harness.data.UnifiedFnDataClient;

import com.bff.gaia.unified.fn.harness.data.PCollectionConsumerRegistry;

import com.bff.gaia.unified.fn.harness.data.PTransformFunctionRegistry;

import com.bff.gaia.unified.fn.harness.state.UnifiedFnStateClient;

import com.bff.gaia.unified.model.pipeline.v1.RunnerApi;

import com.bff.gaia.unified.model.pipeline.v1.RunnerApi.Coder;

import com.bff.gaia.unified.model.pipeline.v1.RunnerApi.PCollection;

import com.bff.gaia.unified.model.pipeline.v1.RunnerApi.PTransform;

import com.bff.gaia.unified.sdk.options.PipelineOptions;



import java.io.IOException;

import java.util.Map;

import java.util.function.Supplier;



/** A factory able to instantiate an appropriate handler for a given PTransform. */

public interface PTransformRunnerFactory<T> {

  /**

   * Creates and returns a handler for a given PTransform. Note that the handler must support

   * processing multiple bundles. The handler will be discarded if an error is thrown during element

   * processing, or during execution of start/finish.

   *

   * @param pipelineOptions Pipeline options

   * @param unifiedFnDataClient A client for handling inbound and outbound data streams.

   * @param unifiedFnStateClient A client for handling state requests.

   * @param pTransformId The id of the PTransform.

   * @param pTransform The PTransform definition.

   * @param processBundleInstructionId A supplier containing the active process bundle instruction

   *     id.

   * @param pCollections A mapping from PCollection id to PCollection definition.

   * @param coders A mapping from coder id to coder definition.

   * @param windowingStrategies

   * @param pCollectionConsumerRegistry A mapping from PCollection id to a collection of consumers.

   *     Note that if this handler is a consumer, it should register itself within this multimap

   *     under the appropriate PCollection ids. Also note that all output consumers needed by this

   *     PTransform (based on the values of the {@link PTransform#getOutputsMap()} will have already

   *     registered within this multimap.

   * @param startFunctionRegistry A class to register a start bundle handler with.

   * @param finishFunctionRegistry A class to register a finish bundle handler with.

   * @param splitListener A listener to be invoked when the PTransform splits itself.

   */

  T createRunnerForPTransform(

	  PipelineOptions pipelineOptions,

	  UnifiedFnDataClient unifiedFnDataClient,

	  UnifiedFnStateClient unifiedFnStateClient,

	  String pTransformId,

	  RunnerApi.PTransform pTransform,

	  Supplier<String> processBundleInstructionId,

	  Map<String, PCollection> pCollections,

	  Map<String, Coder> coders,

	  Map<String, RunnerApi.WindowingStrategy> windowingStrategies,

	  PCollectionConsumerRegistry pCollectionConsumerRegistry,

	  PTransformFunctionRegistry startFunctionRegistry,

	  PTransformFunctionRegistry finishFunctionRegistry,

	  BundleSplitListener splitListener)

      throws IOException;



  /**

   * A registrar which can return a mapping from {@link RunnerApi.FunctionSpec#getUrn()} to a

   * factory capable of instantiating an appropriate handler.

   */

  interface Registrar {

    /**

     * Returns a mapping from {@link RunnerApi.FunctionSpec#getUrn()} to a factory capable of

     * instantiating an appropriate handler.

     */

    Map<String, PTransformRunnerFactory> getPTransformRunnerFactories();

  }

}